<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SipekSDK Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
	<!-- Main table. -->
<TABLE id="MainTable" cellSpacing="0" cellPadding="0" width="100%" border="0">
<!-- First Row,  logo. -->
<TR>
 <TD>
  <TABLE cellSpacing="0" cellPadding="0" width="100%" border="0">
    <TR valign="bottom">

	<TD style="background-image: url(/images/bg1.jpg);">
	<!-- Logo section -->
	<table border="0" class="pj">
		<tr>
		<td vAlign="middle" width="46"><A href="http://sites.google.com/site/sipekvoip"><img alt="sipek logo" src="http://sites.google.com/site/sipekvoip/files/Sipek64x64.png" border="0"></A>
		</td>
		<td vAlign="top">
		<font face="Verdana,Arial,Helvetica" size="5"><b><A style="color: black; text-decoration: none" HREF="/">Sipek Software Development Kit</A></b></FONT><br>

		<FONT face="Arial,Helvetica" size="1"><A style="color: black; text-decoration: none" HREF="/">Open source SIP Software Development Kit - SipekSDK</A></FONT><br>
		<br>
<script type="text/javascript"><!--
google_ad_client = "pub-1698141058269504";
/* 728x15, created 3/21/08 */
google_ad_slot = "1887304858";
google_ad_width = 728;
google_ad_height = 15;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
		</td>
		</tr>
	</table>
	</TD>
    </TR>
  </TABLE>
 </TD>
</TR>

<!-- Second Row, a HR. -->

<TR>
    <td><hr size="2"></td>
</TR>
<!-- Third row, main contents. -->
<TR>
    <TD>
	     <TABLE id="ContentTable" cellSpacing="6" cellPadding="1" width="100%" border="0">
	     <TR valign="top">
		    <TD valign="top" width="160" style="background-image: url(/images/bg2.jpg);">

<h3>Links </h3>

<p><a href="http://sites.google.com/site/sipekvoip">Sipek Projects Home</a></p>

<p><a href="http://sites.google.com/site/sipekvoip/sipeksdk">SipekSdk</a></p>

<p><a href="http://sites.google.com/site/sipekvoip/Home/documentation/tutorial">SipekSdk Tutorial</a></p>

<p><a href="http://code.google.com/p/sipek2/">Sipek Softphone Project Home</a></p>

<p><a href="http://code.google.com/p/sipeksdk/">SipekSDK Project Home</a></p>

<p><a href="http://groups.google.com/group/sipek">Sipek Discussion Group</a></p>
<hr size="2">
<b>About:</b><FONT face="Arial, Verdana" size="1"> Sipek and SipekSDK are created by: Sasa Coh<br>
<br>

<script type="text/javascript"><!--
google_ad_client = "pub-1698141058269504";
/* 160x600, created 3/21/08 */
google_ad_slot = "1219054775";
google_ad_width = 160;
google_ad_height = 600;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
<p></p>

		    </TD>
		    <TD vAlign="top" style="border-left: dotted 1px; border-color=#C0C0C0;">&nbsp;</td>
      <TD>

	<p><A HREF="/">Home</A> --&gt; SipekSDK API Reference</p>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>Sipek</b>.<b>Common</b>.<a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html">IVoipProxy</a>
  </div>
</div>
<div class="contents">
<h1>Sipek.Common.IVoipProxy Class Reference</h1><!-- doxytag: class="Sipek::Common::IVoipProxy" -->VoIP protocol stack interface. Defines some common events invoked by VoIP stack and API methods invoked by user.  
<a href="#_details">More...</a>
<p>
Inherited by Sipek.Common.NullVoipProxy, and <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html">Sipek.Sip.pjsipStackProxy</a>.
<p>

<p>
<a href="class_sipek_1_1_common_1_1_i_voip_proxy-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#442cf10d441c685bcd992baac169215a">initialize</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize VoIP stack.  <a href="#442cf10d441c685bcd992baac169215a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#e1b3ce3b66e7e3f0d35822e4818cf7b0">shutdown</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shutdown VoIP stack.  <a href="#e1b3ce3b66e7e3f0d35822e4818cf7b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#6ed5fdc83af3dc1738a9cedf60d94a87">setCodecPriority</a> (string item, int p)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set codec priority.  <a href="#6ed5fdc83af3dc1738a9cedf60d94a87"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#4bd6f5f41409f3fb0f531c70a1bb3c76">getNoOfCodecs</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get number of codecs in list.  <a href="#4bd6f5f41409f3fb0f531c70a1bb3c76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#305c037ea0d474a3799697f2c3ce1e31">getCodec</a> (int i)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get codec by index.  <a href="#305c037ea0d474a3799697f2c3ce1e31"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract <a class="el" href="class_sipek_1_1_common_1_1_i_call_proxy_interface.html">ICallProxyInterface</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#ba949420d5e8c704234ddaa850f9ee82">createCallProxy</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an instance of call proxy.  <a href="#ba949420d5e8c704234ddaa850f9ee82"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">abstract bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#fbf5cbcd91b33bd85b5d53eedddac162">IsInitialized</a><code> [get, set]</code></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flag indicating stack initialization status.  <a href="#fbf5cbcd91b33bd85b5d53eedddac162"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Events</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">DDtmfDigitReceived&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#8a3a0ce25de883c40687b6e75b1bb8fd">DtmfDigitReceived</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">User Events. A protected virtual method makes possible to invoke events from derived classes.  <a href="#8a3a0ce25de883c40687b6e75b1bb8fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">DMessageWaitingNotification&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#8989dad9660d4d2d32bbefb655da153b">MessageWaitingIndication</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">MessageWaitingIndication event trigger by VoIP stack when MWI indication arrived.  <a href="#8989dad9660d4d2d32bbefb655da153b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">DCallReplaced&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sipek_1_1_common_1_1_i_voip_proxy.html#bf6ac07bf830f7f175ea3f66888cadca">CallReplaced</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Notification that call is being replaced.  <a href="#bf6ac07bf830f7f175ea3f66888cadca"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
VoIP protocol stack interface. Defines some common events invoked by VoIP stack and API methods invoked by user. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="442cf10d441c685bcd992baac169215a"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::initialize" ref="442cf10d441c685bcd992baac169215a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract int Sipek.Common.IVoipProxy.initialize           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize VoIP stack. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

<p>Implemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#e9af525eac3d8bf7b50fe61094846176">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<a class="anchor" name="e1b3ce3b66e7e3f0d35822e4818cf7b0"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::shutdown" ref="e1b3ce3b66e7e3f0d35822e4818cf7b0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Sipek.Common.IVoipProxy.shutdown           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Shutdown VoIP stack. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

<p>Reimplemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#1ded8267c18a7b793feba64b4afb0073">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<a class="anchor" name="6ed5fdc83af3dc1738a9cedf60d94a87"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::setCodecPriority" ref="6ed5fdc83af3dc1738a9cedf60d94a87" args="(string item, int p)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract void Sipek.Common.IVoipProxy.setCodecPriority           </td>
          <td>(</td>
          <td class="paramtype">string&nbsp;</td>
          <td class="paramname"> <em>item</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>p</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set codec priority. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>item</em>&nbsp;</td><td>Codec Name</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>priority</td></tr>
  </table>
</dl>

<p>Implemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#f4fbcca33b4c3bee11f41ebd9692f319">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<a class="anchor" name="4bd6f5f41409f3fb0f531c70a1bb3c76"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::getNoOfCodecs" ref="4bd6f5f41409f3fb0f531c70a1bb3c76" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract int Sipek.Common.IVoipProxy.getNoOfCodecs           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get number of codecs in list. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of codecs</dd></dl>

<p>Implemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#2c5c21a9e13c5ceb78dea29e4d0cd0d3">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<a class="anchor" name="305c037ea0d474a3799697f2c3ce1e31"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::getCodec" ref="305c037ea0d474a3799697f2c3ce1e31" args="(int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract string Sipek.Common.IVoipProxy.getCodec           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>i</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get codec by index. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>i</em>&nbsp;</td><td>codec index</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Codec Name</dd></dl>

<p>Implemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#02d1eb2c156567cd19f4cd347ce495d4">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<a class="anchor" name="ba949420d5e8c704234ddaa850f9ee82"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::createCallProxy" ref="ba949420d5e8c704234ddaa850f9ee82" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract <a class="el" href="class_sipek_1_1_common_1_1_i_call_proxy_interface.html">ICallProxyInterface</a> Sipek.Common.IVoipProxy.createCallProxy           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates an instance of call proxy. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

<p>Implemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#cccdacaac68a255ba7ab101c7c77b661">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<hr><h2>Property Documentation</h2>
<a class="anchor" name="fbf5cbcd91b33bd85b5d53eedddac162"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::IsInitialized" ref="fbf5cbcd91b33bd85b5d53eedddac162" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">abstract bool Sipek.Common.IVoipProxy.IsInitialized<code> [get, set]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Flag indicating stack initialization status. 
<p>

<p>Reimplemented in <a class="el" href="class_sipek_1_1_sip_1_1pjsip_stack_proxy.html#18ccc561ff651e15fcb5648f383ea6b8">Sipek.Sip.pjsipStackProxy</a>.</p>

</div>
</div><p>
<hr><h2>Event Documentation</h2>
<a class="anchor" name="8a3a0ce25de883c40687b6e75b1bb8fd"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::DtmfDigitReceived" ref="8a3a0ce25de883c40687b6e75b1bb8fd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DDtmfDigitReceived Sipek.Common.IVoipProxy.DtmfDigitReceived          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
User Events. A protected virtual method makes possible to invoke events from derived classes. 
<p>
DtmfDigitReceived event trigger by VoIP stack when DTMF is detected 
</div>
</div><p>
<a class="anchor" name="8989dad9660d4d2d32bbefb655da153b"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::MessageWaitingIndication" ref="8989dad9660d4d2d32bbefb655da153b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DMessageWaitingNotification Sipek.Common.IVoipProxy.MessageWaitingIndication          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
MessageWaitingIndication event trigger by VoIP stack when MWI indication arrived. 
<p>

</div>
</div><p>
<a class="anchor" name="bf6ac07bf830f7f175ea3f66888cadca"></a><!-- doxytag: member="Sipek::Common::IVoipProxy::CallReplaced" ref="bf6ac07bf830f7f175ea3f66888cadca" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DCallReplaced Sipek.Common.IVoipProxy.CallReplaced          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Notification that call is being replaced. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>AbstractWrapper.cs</ul>
</div>
<hr><center>
<font face="Arial,Helvetica" size="1">SipekSdk - Open Source VoIP Software Development Kit<br>
<i>(c)2007-2008 Sasa Coh </i><a href="mailto:sasacoh@gmail.com">sasacoh@gmail.com</a></font>
</center>

				</TD>
				<TD vAlign="top"></TD>

			    </TR>
			</TABLE>
		    </TD>
		</TR>
	    </TABLE>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-2163858-11");
pageTracker._trackPageview();
</script>

</BODY>
</HTML>
